POST Dashboard/DashboardPulseAppointments?companyId[0]={companyId[0]}&companyId[1]={companyId[1]}&startDate={startDate}&endDate={endDate}&secondaryStartDate={secondaryStartDate}&secondaryEndDate={secondaryEndDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

Collection of integer

Required
startDate

date

Required
endDate

date

Required
secondaryStartDate

date

None.
secondaryEndDate

date

None.

Body Parameters

IConnect.Web.ReportingApi.Models.AppointmentsDashboardFilter
NameDescriptionTypeAdditional information
BookingTypes

Collection of IConnect.Domain.Bookings.BookingType

None.
Companies

Collection of integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "BookingTypes": [
    0,
    0
  ],
  "Companies": [
    1,
    2
  ]
}

application/xml, text/xml

Sample: 
<AppointmentsDashboardFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Web.ReportingApi.Models">
  <Companies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Companies>
  <BookingTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Bookings">
    <d2p1:BookingType>Appointment</d2p1:BookingType>
    <d2p1:BookingType>Appointment</d2p1:BookingType>
  </BookingTypes>
</AppointmentsDashboardFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.Domain.Dashboard.PulseDashboardPairOfIConnect.Domain.Dashboard.PulseDashboardAppointments
NameDescriptionTypeAdditional information
Primary

IConnect.Domain.Dashboard.PulseDashboardAppointments

None.
Secondary

IConnect.Domain.Dashboard.PulseDashboardAppointments

None.

Response Formats

application/json, text/json

Sample: 
{
  "Primary": {
    "ByType": {
      "Appointment": {
        "Count": 1,
        "TotalAppointmentsCost": 2.0
      }
    },
    "Count": 1,
    "TotalAppointmentsCost": 2.0
  },
  "Secondary": {
    "ByType": {
      "Appointment": {
        "Count": 1,
        "TotalAppointmentsCost": 2.0
      }
    },
    "Count": 1,
    "TotalAppointmentsCost": 2.0
  }
}

application/xml, text/xml

Sample: 
<PulseDashboardPairOfPulseDashboardAppointmentsaaaYI6zx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
  <Primary>
    <Count>1</Count>
    <TotalAppointmentsCost>2</TotalAppointmentsCost>
    <ByType xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfBookingTypePulseDashboardAppointmentsStatsbkOLqY9D>
        <d3p1:Key>Appointment</d3p1:Key>
        <d3p1:Value>
          <Count>1</Count>
          <TotalAppointmentsCost>2</TotalAppointmentsCost>
        </d3p1:Value>
      </d3p1:KeyValueOfBookingTypePulseDashboardAppointmentsStatsbkOLqY9D>
    </ByType>
  </Primary>
  <Secondary>
    <Count>1</Count>
    <TotalAppointmentsCost>2</TotalAppointmentsCost>
    <ByType xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfBookingTypePulseDashboardAppointmentsStatsbkOLqY9D>
        <d3p1:Key>Appointment</d3p1:Key>
        <d3p1:Value>
          <Count>1</Count>
          <TotalAppointmentsCost>2</TotalAppointmentsCost>
        </d3p1:Value>
      </d3p1:KeyValueOfBookingTypePulseDashboardAppointmentsStatsbkOLqY9D>
    </ByType>
  </Secondary>
</PulseDashboardPairOfPulseDashboardAppointmentsaaaYI6zx>